Resource URL: /platform/<<version=3>>/antivirus/policies/<NAME>

    Overview: This resource represents the antivirus scan policies configured
              on a cluster.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve one antivirus scan policy.

       URL: GET /platform/<<version=3>>/antivirus/policies/<NAME>

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "policies": {
      "items": {
        "type": "object", 
        "description": "An antivirus scan policy.", 
        "properties": {
          "impact": {
            "type": [
              "string", 
              "null"
            ], 
            "description": "The priority of the antivirus scan job.  Must be a valid job engine impact policy, or null to use the default impact."
          }, 
          "paths": {
            "items": {
              "pattern": "^/ifs.*", 
              "type": "string"
            }, 
            "type": "array", 
            "description": "Paths to include in the scan."
          }, 
          "description": {
            "type": "string", 
            "description": "A description for the policy."
          }, 
          "schedule": {
            "type": [
              "string", 
              "null"
            ], 
            "description": "The schedule for running scans in isi date format.  Examples include: 'every Friday' or 'every day at 4:00'.  A null value means the policy is manually scheduled."
          }, 
          "recursion_depth": {
            "type": "integer", 
            "description": "The depth to recurse in directories.  The default of -1 gives unlimited recursion."
          }, 
          "enabled": {
            "type": "boolean", 
            "description": "Whether the policy is enabled."
          }, 
          "last_run": {
            "type": "integer", 
            "description": "The epoch time of the last run of this policy."
          }, 
          "force_run": {
            "type": "boolean", 
            "description": "Forces the scan to run regardless of whether the files were recently scanned."
          }, 
          "id": {
            "type": "string", 
            "description": "A unique identifier for the policy."
          }, 
          "name": {
            "type": "string", 
            "description": "The name of the policy."
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify an antivirus scan policy.

       URL: PUT /platform/<<version=3>>/antivirus/policies/<NAME>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "An antivirus scan policy.", 
  "properties": {
    "impact": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The priority of the antivirus scan job.  Must be a valid job engine impact policy, or null to use the default impact."
    }, 
    "paths": {
      "items": {
        "pattern": "^/ifs.*", 
        "type": "string"
      }, 
      "type": "array", 
      "description": "Paths to include in the scan."
    }, 
    "description": {
      "type": "string", 
      "description": "A description for the policy."
    }, 
    "schedule": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The schedule for running scans in isi date format.  Examples include: 'every Friday' or 'every day at 4:00'.  A null value means the policy is manually scheduled."
    }, 
    "recursion_depth": {
      "type": "integer", 
      "description": "The depth to recurse in directories.  The default of -1 gives unlimited recursion."
    }, 
    "enabled": {
      "type": "boolean", 
      "description": "Whether the policy is enabled."
    }, 
    "force_run": {
      "type": "boolean", 
      "description": "Forces the scan to run regardless of whether the files were recently scanned."
    }, 
    "name": {
      "type": "string", 
      "description": "The name of the policy."
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete an antivirus scan policy.

          URL: DELETE /platform/<<version=3>>/antivirus/policies/<NAME>

There are no query arguments for this method.

There is no response body for this method.
